home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / tclX6.4c / dist / tcllib / help / status / info < prev    next >
Encoding:
Text File  |  1992-11-10  |  6.2 KB  |  117 lines
  1.           info option ?arg arg ...?
  2.                Provide information about various internals to the  Tcl
  3.                interpreter.    The   legal   option's  (which  may  be
  4.                abbreviated) are:
  5.  
  6.                info args procname
  7.                     Returns  a  list  containing  the  names  of   the
  8.                     arguments   to   procedure   procname,  in  order.
  9.                     Procname  must  be  the  name  of  a  Tcl  command
  10.                     procedure.
  11.  
  12.                info body procname
  13.                     Returns the body of procedure procname.   Procname
  14.                     must be the name of a Tcl command procedure.
  15.  
  16.                info cmdcount
  17.                     Returns a count of the total  number  of  commands
  18.                     that have been invoked in this interpreter.
  19.  
  20.                info commands ?pattern?
  21.                     If pattern isn't  specified,  returns  a  list  of
  22.                     names  of all the Tcl commands, including both the
  23.                     built-in commands written in  C  and  the  command
  24.                     procedures  defined  using  the  proc command.  If
  25.                     pattern is specified, only  those  names  matching
  26.                     pattern  are  returned.   Matching  is  determined
  27.                     using the same rules as for string match.
  28.  
  29.                info default procname arg varname
  30.                     Procname  must  be  the  name  of  a  Tcl  command
  31.                     procedure  and arg must be the name of an argument
  32.                     to that procedure.  If arg doesn't have a  default
  33.                     value  then  the  command returns 0.  Otherwise it
  34.                     returns 1 and places the default value of arg into
  35.                     variable varname.
  36.  
  37.                info exists varName
  38.                     Returns 1 if the variable named varName exists  in
  39.                     the  current  context (either as a global or local
  40.                     variable), returns 0 otherwise.
  41.  
  42.                info globals ?pattern?
  43.                     If pattern isn't specified, returns a list of  all
  44.                     the  names  of currently-defined global variables.
  45.                     If pattern is specified, only those names matching
  46.                     pattern  are  returned.   Matching  is  determined
  47.                     using the same rules as for string match.
  48.  
  49.                info level ?number?
  50.                     If number is not specified, this command returns a
  51.                     number  giving  the  stack  level  of the invoking
  52.                     procedure, or 0 if the command is invoked at  top-
  53.                     level.  If number is specified, then the result is
  54.                     a list consisting of the name  and  arguments  for
  55.                     the  procedure  call at level number on the stack.
  56.                     If number is positive then it selects a particular
  57.                     stack  level  (1  refers  to  the  top-most active
  58.                     procedure, 2 to the procedure it  called,  and  so
  59.                     on);  otherwise  it  gives a level relative to the
  60.                     current level (0 refers to the current  procedure,
  61.                     -1  to  its  caller,  and so on).  See the uplevel
  62.                     command for more information on what stack  levels
  63.                     mean.
  64.  
  65.                info library
  66.                     Returns the name of the library directory in which
  67.                     standard  Tcl  scripts are stored.  If there is no
  68.                     such   directory   defined   for    the    current
  69.                     installation  then an error is generated.  See the
  70.                     library manual entry for details of the facilities
  71.                     provided by the Tcl script library.  Normally each
  72.                     application will have its own application-specific
  73.                     library  in  addition  to  the Tcl script library;
  74.                     the location of the  application-specific  library
  75.                     should be kept in the $appLibrary global variable.
  76.  
  77.                info locals ?pattern?
  78.                     If pattern isn't specified, returns a list of  all
  79.                     the  names  of  currently-defined local variables,
  80.                     including arguments to the current  procedure,  if
  81.                     any.   Variables defined with the global and upvar
  82.                     commands will not  be  returned.   If  pattern  is
  83.                     specified,  only  those names matching pattern are
  84.                     returned.  Matching is determined using  the  same
  85.                     rules as for string match.
  86.  
  87.                info procs ?pattern?
  88.                     If pattern isn't specified, returns a list of  all
  89.                     the  names  of Tcl command procedures.  If pattern
  90.                     is specified, only those  names  matching  pattern
  91.                     are  returned.   Matching  is determined using the
  92.                     same rules as for string match.
  93.  
  94.                info script
  95.                     If a Tcl script file is currently being  evaluated
  96.                     (i.e.  there  is  a call to Tcl_EvalFile active or
  97.                     there  is  an  active  invocation  of  the  source
  98.                     command),  then  this  command returns the name of
  99.                     the innermost file being processed.  Otherwise the
  100.                     command returns an empty string.
  101.  
  102.                info tclversion
  103.                     Returns the version number for this version of Tcl
  104.                     in  the  form  x.y,  where  changes to x represent
  105.                     major changes with probable incompatibilities  and
  106.                     changes  to y represent small enhancements and bug
  107.                     fixes that retain backward compatibility.
  108.  
  109.                info vars ?pattern?
  110.                     If pattern isn't specified, returns a list of  all
  111.                     the    names   of   currently-visible   variables,
  112.                     including  both   locals   and   currently-visible
  113.                     globals.   If  pattern  is  specified,  only those
  114.                     names matching pattern are returned.  Matching  is
  115.                     determined  using  the  same  rules  as for string
  116.                     match.
  117.